<!DOCTYPE HTML>

<html lang="en">
<head>

<title>UsernamePasswordAuthenticationFilter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="UsernamePasswordAuthenticationFilter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="UsernamePasswordAuthenticationFilter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.authentication</a></div>
<h2 title="Class UsernamePasswordAuthenticationFilter" class="title">Class UsernamePasswordAuthenticationFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.web.filter.GenericFilterBean</li>
<li>
<ul class="inheritance">
<li><a href="AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.Filter</code>, <code>org.springframework.beans.factory.Aware</code>, <code>org.springframework.beans.factory.BeanNameAware</code>, <code>org.springframework.beans.factory.DisposableBean</code>, <code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.context.ApplicationEventPublisherAware</code>, <code>org.springframework.context.EnvironmentAware</code>, <code>org.springframework.context.MessageSourceAware</code>, <code>org.springframework.core.env.EnvironmentCapable</code>, <code>org.springframework.web.context.ServletContextAware</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">UsernamePasswordAuthenticationFilter</span>
extends <a href="AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></pre>
<div class="block">Processes an authentication form submission. Called
<code>AuthenticationProcessingFilter</code> prior to Spring Security 3.0.
<p>
Login forms must present two parameters to this filter: a username and password. The
default parameter names to use are contained in the static fields
<a href="UsernamePasswordAuthenticationFilter.html#SPRING_SECURITY_FORM_USERNAME_KEY"><code>SPRING_SECURITY_FORM_USERNAME_KEY</code></a> and
<a href="UsernamePasswordAuthenticationFilter.html#SPRING_SECURITY_FORM_PASSWORD_KEY"><code>SPRING_SECURITY_FORM_PASSWORD_KEY</code></a>. The parameter names can also be changed by
setting the <code>usernameParameter</code> and <code>passwordParameter</code> properties.
<p>
This filter by default responds to the URL <code>/login</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#SPRING_SECURITY_FORM_PASSWORD_KEY">SPRING_SECURITY_FORM_PASSWORD_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#SPRING_SECURITY_FORM_USERNAME_KEY">SPRING_SECURITY_FORM_USERNAME_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.security.web.authentication.<a href="AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="AbstractAuthenticationProcessingFilter.html#authenticationDetailsSource">authenticationDetailsSource</a>, <a href="AbstractAuthenticationProcessingFilter.html#eventPublisher">eventPublisher</a>, <a href="AbstractAuthenticationProcessingFilter.html#messages">messages</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>logger</code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#%3Cinit%3E()">UsernamePasswordAuthenticationFilter</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#%3Cinit%3E(org.springframework.security.authentication.AuthenticationManager)">UsernamePasswordAuthenticationFilter</a></span>&#8203;(<a href="../../authentication/AuthenticationManager.html" title="interface in org.springframework.security.authentication">AuthenticationManager</a>&nbsp;authenticationManager)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Performs actual authentication.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#getPasswordParameter()">getPasswordParameter</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#getUsernameParameter()">getUsernameParameter</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#obtainPassword(javax.servlet.http.HttpServletRequest)">obtainPassword</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Enables subclasses to override the composition of the password, such as by
including additional values and a separator.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#obtainUsername(javax.servlet.http.HttpServletRequest)">obtainUsername</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Enables subclasses to override the composition of the username, such as by
including additional values and a separator.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#setDetails(javax.servlet.http.HttpServletRequest,org.springframework.security.authentication.UsernamePasswordAuthenticationToken)">setDetails</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
<a href="../../authentication/UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;authRequest)</code></th>
<td class="colLast">
<div class="block">Provided so that subclasses may configure what is put into the authentication
request's details property.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#setPasswordParameter(java.lang.String)">setPasswordParameter</a></span>&#8203;(java.lang.String&nbsp;passwordParameter)</code></th>
<td class="colLast">
<div class="block">Sets the parameter name which will be used to obtain the password from the login
request..</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#setPostOnly(boolean)">setPostOnly</a></span>&#8203;(boolean&nbsp;postOnly)</code></th>
<td class="colLast">
<div class="block">Defines whether only HTTP POST requests will be allowed by this filter.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UsernamePasswordAuthenticationFilter.html#setUsernameParameter(java.lang.String)">setUsernameParameter</a></span>&#8203;(java.lang.String&nbsp;usernameParameter)</code></th>
<td class="colLast">
<div class="block">Sets the parameter name which will be used to obtain the username from the login
request.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.<a href="AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="AbstractAuthenticationProcessingFilter.html#afterPropertiesSet()">afterPropertiesSet</a>, <a href="AbstractAuthenticationProcessingFilter.html#doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">doFilter</a>, <a href="AbstractAuthenticationProcessingFilter.html#getAllowSessionCreation()">getAllowSessionCreation</a>, <a href="AbstractAuthenticationProcessingFilter.html#getAuthenticationManager()">getAuthenticationManager</a>, <a href="AbstractAuthenticationProcessingFilter.html#getFailureHandler()">getFailureHandler</a>, <a href="AbstractAuthenticationProcessingFilter.html#getRememberMeServices()">getRememberMeServices</a>, <a href="AbstractAuthenticationProcessingFilter.html#getSuccessHandler()">getSuccessHandler</a>, <a href="AbstractAuthenticationProcessingFilter.html#requiresAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">requiresAuthentication</a>, <a href="AbstractAuthenticationProcessingFilter.html#setAllowSessionCreation(boolean)">setAllowSessionCreation</a>, <a href="AbstractAuthenticationProcessingFilter.html#setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)">setApplicationEventPublisher</a>, <a href="AbstractAuthenticationProcessingFilter.html#setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource)">setAuthenticationDetailsSource</a>, <a href="AbstractAuthenticationProcessingFilter.html#setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler)">setAuthenticationFailureHandler</a>, <a href="AbstractAuthenticationProcessingFilter.html#setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager)">setAuthenticationManager</a>, <a href="AbstractAuthenticationProcessingFilter.html#setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler)">setAuthenticationSuccessHandler</a>, <a href="AbstractAuthenticationProcessingFilter.html#setContinueChainBeforeSuccessfulAuthentication(boolean)">setContinueChainBeforeSuccessfulAuthentication</a>, <a href="AbstractAuthenticationProcessingFilter.html#setFilterProcessesUrl(java.lang.String)">setFilterProcessesUrl</a>, <a href="AbstractAuthenticationProcessingFilter.html#setMessageSource(org.springframework.context.MessageSource)">setMessageSource</a>, <a href="AbstractAuthenticationProcessingFilter.html#setRememberMeServices(org.springframework.security.web.authentication.RememberMeServices)">setRememberMeServices</a>, <a href="AbstractAuthenticationProcessingFilter.html#setRequiresAuthenticationRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)">setRequiresAuthenticationRequestMatcher</a>, <a href="AbstractAuthenticationProcessingFilter.html#setSessionAuthenticationStrategy(org.springframework.security.web.authentication.session.SessionAuthenticationStrategy)">setSessionAuthenticationStrategy</a>, <a href="AbstractAuthenticationProcessingFilter.html#successfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,javax.servlet.FilterChain,org.springframework.security.core.Authentication)">successfulAuthentication</a>, <a href="AbstractAuthenticationProcessingFilter.html#unsuccessfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.AuthenticationException)">unsuccessfulAuthentication</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="SPRING_SECURITY_FORM_USERNAME_KEY">

</a>
<ul class="blockList">
<li class="blockList">
<h4>SPRING_SECURITY_FORM_USERNAME_KEY</h4>
<pre>public static final&nbsp;java.lang.String SPRING_SECURITY_FORM_USERNAME_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter.SPRING_SECURITY_FORM_USERNAME_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="SPRING_SECURITY_FORM_PASSWORD_KEY">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SPRING_SECURITY_FORM_PASSWORD_KEY</h4>
<pre>public static final&nbsp;java.lang.String SPRING_SECURITY_FORM_PASSWORD_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter.SPRING_SECURITY_FORM_PASSWORD_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>UsernamePasswordAuthenticationFilter</h4>
<pre>public&nbsp;UsernamePasswordAuthenticationFilter()</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.authentication.AuthenticationManager)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UsernamePasswordAuthenticationFilter</h4>
<pre>public&nbsp;UsernamePasswordAuthenticationFilter&#8203;(<a href="../../authentication/AuthenticationManager.html" title="interface in org.springframework.security.authentication">AuthenticationManager</a>&nbsp;authenticationManager)</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>attemptAuthentication</h4>
<pre class="methodSignature">public&nbsp;<a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;attemptAuthentication&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                                            javax.servlet.http.HttpServletResponse&nbsp;response)
                                     throws <a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="AbstractAuthenticationProcessingFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">AbstractAuthenticationProcessingFilter</a></code></span></div>
<div class="block">Performs actual authentication.
<p>
The implementation should do one of the following:
<ol>
<li>Return a populated authentication token for the authenticated user, indicating
successful authentication</li>
<li>Return null, indicating that the authentication process is still in progress.
Before returning, the implementation should perform any additional work required to
complete the process.</li>
<li>Throw an <tt>AuthenticationException</tt> if the authentication process
fails</li>
</ol></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractAuthenticationProcessingFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></code>&nbsp;in class&nbsp;<code><a href="AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - from which to extract parameters and perform the authentication</dd>
<dd><code>response</code> - the response, which may be needed if the implementation has to do a
redirect as part of a multi-stage authentication process (such as OpenID).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authenticated user token, or null if authentication is incomplete.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></code> - if authentication fails.</dd>
</dl>
</li>
</ul>
<a id="obtainPassword(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>obtainPassword</h4>
<pre class="methodSignature">@Nullable
protected&nbsp;java.lang.String&nbsp;obtainPassword&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Enables subclasses to override the composition of the password, such as by
including additional values and a separator.
<p>
This might be used for example if a postcode/zipcode was required in addition to
the password. A delimiter such as a pipe (|) should be used to separate the
password and extended value(s). The <code>AuthenticationDao</code> will need to
generate the expected password in a corresponding manner.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - so that request attributes can be retrieved</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the password that will be presented in the <code>Authentication</code>
request token to the <code>AuthenticationManager</code></dd>
</dl>
</li>
</ul>
<a id="obtainUsername(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>obtainUsername</h4>
<pre class="methodSignature">@Nullable
protected&nbsp;java.lang.String&nbsp;obtainUsername&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Enables subclasses to override the composition of the username, such as by
including additional values and a separator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - so that request attributes can be retrieved</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the username that will be presented in the <code>Authentication</code>
request token to the <code>AuthenticationManager</code></dd>
</dl>
</li>
</ul>
<a id="setDetails(javax.servlet.http.HttpServletRequest,org.springframework.security.authentication.UsernamePasswordAuthenticationToken)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setDetails</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;setDetails&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                          <a href="../../authentication/UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;authRequest)</pre>
<div class="block">Provided so that subclasses may configure what is put into the authentication
request's details property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - that an authentication request is being created for</dd>
<dd><code>authRequest</code> - the authentication request object that should have its details
set</dd>
</dl>
</li>
</ul>
<a id="setUsernameParameter(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsernameParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setUsernameParameter&#8203;(java.lang.String&nbsp;usernameParameter)</pre>
<div class="block">Sets the parameter name which will be used to obtain the username from the login
request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>usernameParameter</code> - the parameter name. Defaults to "username".</dd>
</dl>
</li>
</ul>
<a id="setPasswordParameter(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setPasswordParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPasswordParameter&#8203;(java.lang.String&nbsp;passwordParameter)</pre>
<div class="block">Sets the parameter name which will be used to obtain the password from the login
request..</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>passwordParameter</code> - the parameter name. Defaults to "password".</dd>
</dl>
</li>
</ul>
<a id="setPostOnly(boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setPostOnly</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPostOnly&#8203;(boolean&nbsp;postOnly)</pre>
<div class="block">Defines whether only HTTP POST requests will be allowed by this filter. If set to
true, and an authentication request is received which is not a POST request, an
exception will be raised immediately and authentication will not be attempted. The
<tt>unsuccessfulAuthentication()</tt> method will be called as if handling a failed
authentication.
<p>
Defaults to <tt>true</tt> but may be overridden by subclasses.</div>
</li>
</ul>
<a id="getUsernameParameter()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsernameParameter</h4>
<pre class="methodSignature">public final&nbsp;java.lang.String&nbsp;getUsernameParameter()</pre>
</li>
</ul>
<a id="getPasswordParameter()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPasswordParameter</h4>
<pre class="methodSignature">public final&nbsp;java.lang.String&nbsp;getPasswordParameter()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="UsernamePasswordAuthenticationFilter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="UsernamePasswordAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040ddd35afe97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
